Get Bucket
AutomatR.AWS.Activities.GetBucket
The "Get Bucket" activity in AutomatR is part of the AWS S3 (Simple Storage Service) activities package, enabling automation processes to retrieve information about a specific Amazon S3 bucket. This activity streamlines the process of obtaining details such as creation date for a specified bucket, enhancing the efficiency of automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Access Key ID | Provides the encrypted access key ID for your AWS account, enabling connection to the AWS S3 service. String variables containing the access key ID. |
| Secret Access Key | Provides the encrypted secret access key for your AWS account, enabling connection to the AWS S3 service. String variables containing the secret access key. |
| Region | Specifies the Amazon S3 region associated with the bucket from which information will be retrieved. Use the RegionEndpoint enumeration to set the region. |
| Bucket Name | Specifies the name of the Amazon S3 bucket for which information will be retrieved. String variables containing the bucket name. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variable or argument containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Get Bucket" activity. Useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the wait time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Result | Outputs the result of the "Get Bucket" operation, providing the creation date of the specified bucket. Variables of relevant types (e.g., DateTime variables) to store the operation result. |
How to use:
- Drag and drop the "Get Bucket" activity onto the workflow.
- Configure the properties by providing the required inputs, such as access key ID, secret access key, Amazon S3 region, and the name of the bucket for which information is to be retrieved.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to retrieve information about the specified Amazon S3 bucket.
Example: Consider an example where the "Get Bucket" activity is used to obtain the creation date of an S3 bucket named "MyDataBucket":
Get Bucket:
Display Name: "Get S3 Bucket Info"
Access Key ID: "**************"
Secret Access Key: "**************"
Region: "us-west-2"
Bucket Name: "MyDataBucket"
Result: bucketCreationDate
In this example, the activity retrieves and outputs the creation date of the "MyDataBucket" S3 bucket. The result is stored in the DateTime variable "bucketCreationDate" for further handling in the workflow.